home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / qbbs / 1edit300.zip / 1EDIT.DOC next >
Text File  |  1992-10-03  |  47KB  |  1,501 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                     +----------------------------------------+
  14.                     |  +----------------------------------+  |
  15.                     |  |         -*-  1-Edit  -*-         |  |
  16.                     |  +----------------------------------+  |
  17.                     +----------------------------------------+
  18.  
  19.  
  20.                                   Version: 3.00
  21.  
  22.                                        For
  23.  
  24.                                QuickBBS v2.75-2.76
  25.  
  26.  
  27.                                         by
  28.  
  29.  
  30.                                     Bob Ransom
  31.  
  32.  
  33.  
  34.  
  35.                                 Copyright (c) 1992
  36.                                All Rights Reserved
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                  +---------------------------------------------+
  68.                  |              TABLE OF CONTENTS              |
  69.                  +---------------------------------------------+
  70.  
  71.  
  72.           What Is 1-Edit .....................................  2
  73.           Shareware & Warranty Info ..........................  3
  74.           FOSSILS, ANSI.SYS, and Other Requirements ..........  4
  75.                LOCAL.DEF File ................................  5
  76.                Direct Screen Writes ..........................  6
  77.                Locked COM Ports ..............................  6
  78.                Directories ...................................  6
  79.           Command Line Syntax ................................  8
  80.                Colors ........................................  8
  81.                Drop to DOS Security Level ....................  8
  82.                Directory Commands ............................  8
  83.                Blocking the Menu Editor ......................  8
  84.                User Editor Security ..........................  8
  85.           Getting Started .................................... 10
  86.                Setting Up 1-Edit Within QuickBBS ............. 10
  87.                QuickBBS's External User Editor (*W command) .. 11
  88.           The Menu Editor .................................... 13
  89.           The User Editor .................................... 15
  90.                Mass Updates .................................. 15
  91.                Security "Jumping" (-J parameter) ............. 16
  92.                Editing Your Own User Record .................. 16
  93.                1-Edit Lite (1EDITL.EXE) ...................... 17
  94.           Drop To DOS ........................................ 18
  95.                Local Drop .................................... 18
  96.                Remote Drop ................................... 18
  97.                DOSSHELL.BAT .................................. 19
  98.           Multi-Node Setup ................................... 20
  99.                The -N Parameter .............................. 20
  100.                The -U Parameter .............................. 21
  101.           Registering 1-Edit ................................. 22
  102.                Keys .......................................... 22
  103.           Final Notes ........................................ 25
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.           1-Edit Documentation                             Page 1
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.                  +---------------------------------------------+
  128.                  |                WHAT IS 1-EDIT?              |
  129.                  +---------------------------------------------+
  130.  
  131.  
  132.           1-Edit is a combined User Editor and Menu Editor for QuickBBS
  133.           v2.75-2.76 systems designed to work reliably from remote.
  134.           Features include:
  135.  
  136.                    - Built-in FOSSIL routines for easy to operate remote
  137.                    performance.
  138.  
  139.                    - Complete editing capabilities of all User record
  140.                    fields.
  141.  
  142.                    - Complete menu editing capabilities including
  143.                    adding, deleting, renaming, and copying menus, plus
  144.                    full editing of each menu.
  145.  
  146.                    - Full carrier-detection which returns to QuickBBS
  147.                    when carrier is dropped.
  148.  
  149.                    - Automatic high-speed performance with locked ports
  150.                    at up to 38,400 baud.
  151.  
  152.                    - Ability to work in multi-node setups.
  153.  
  154.                    - Status line showing user name, baud and modem
  155.                    settings, and time remaining (registered versions
  156.                    only.)
  157.  
  158.                    - User definable colors.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.           1-Edit Documentation                             Page 2
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.                  +---------------------------------------------+
  188.                  |      1-EDIT: SHAREWARE & WARRANTY INFO      |
  189.                  +---------------------------------------------+
  190.  
  191.  
  192.  
  193.           Here comes the dull stuff...
  194.  
  195.  
  196.           SHAREWARE INFO
  197.           --------------
  198.  
  199.           This program is released to the public as shareware.  This
  200.           means try the program and if you like it and continue to use
  201.           it, you must register it within a reasonable amount of time.
  202.           This program is not freeware nor public domain software;
  203.           rather it is copyrighted material with all rights reserved.
  204.           You are granted only a limited license to test this software
  205.           to see if it meets your needs.
  206.  
  207.           You may copy 1-Edit and transfer it to others provided you
  208.           follow these brief rules:
  209.  
  210.           1- You may not change the program, its documentation, any
  211.           ancillary programs or files included in the archive, or the
  212.           archive itself, in any way without express written consent
  213.           from me, the author.
  214.  
  215.           2- You may not sell the program to others.  This program may
  216.           be distributed on pay systems, but not on a "fee per download"
  217.           basis.
  218.  
  219.           3- You may not distribute this product with any other products
  220.           without express written consent from me.
  221.  
  222.           Registration of 1-Edit is a cheap 10 bucks and covers you for
  223.           all future releases of the program.  More information on
  224.           registration is included later in this document.
  225.  
  226.  
  227.           WARRANTY
  228.           --------
  229.  
  230.           No warranty of any kind, covering either hardware or software
  231.           damage, is expressed nor implied.  If you choose to use this
  232.           program, you do so at your own risk.
  233.  
  234.  
  235.  
  236.  
  237.           1-Edit Documentation                             Page 3
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.                  +---------------------------------------------+
  248.                  |  FOSSILS, ANSI.SYS, and OTHER REQUIREMENTS  |
  249.                  +---------------------------------------------+
  250.  
  251.  
  252.  
  253.           There are a few things you should know before attempting to
  254.           boot 1-Edit for the first time:
  255.  
  256.  
  257.           Software Version
  258.           ----------------
  259.  
  260.           This version, 3.00, of 1-Edit is designed to work with
  261.           QuickBBS v2.75 & 2.76.  If you are, for some reason, still
  262.           running an older version of QuickBBS (2.64-2.66), please use
  263.           1-Edit v1.01.
  264.  
  265.  
  266.           FOSSIL Driver
  267.           -------------
  268.  
  269.           1-Edit requires that a FOSSIL driver be installed and active
  270.           at all times.  This shouldn't prove to be much of a hindrance
  271.           since 1-Edit was designed for remote use -- and QuickBBS also
  272.           requires the FOSSIL be installed and active.  1-Edit has been
  273.           tested under several versions of both the X00 and BNU drivers;
  274.           either should work fine.  However, if you are using either as
  275.           a TSR (rather than as a standard "DEVICE="), you must make
  276.           sure that the FOSSIL isn't being removed from memory when you
  277.           shell or exit your BBS or mailer.
  278.  
  279.  
  280.           ANSI Graphics
  281.           -------------
  282.  
  283.           1-Edit requires all users of the program to have the ANSI.SYS
  284.           driver installed -- both on the BBS side and on the remote
  285.           side.  This shouldn't be much of a problem as I figure 99.98%
  286.           of all sysops do.  If you're unfamiliar with ANSI.SYS and its
  287.           installation, please refer to your DOS manual.  ANSI.SYS is
  288.           included with all versions of DOS.
  289.  
  290.           I've received a few messages from sysops who would prefer that
  291.           the program *not* use ANSI graphics as they do their work from
  292.           non-ANSI machines (like VT-220 terms on a VAX).  Someday I
  293.           hope to take care of this problem, making ANSI an option
  294.           rather than a requirement.  I'm using ANSI not so much for
  295.  
  296.  
  297.           1-Edit Documentation                             Page 4
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.           color as for cursor positioning and movement, and I haven't
  308.           quite figured a way around the use of ANSI.
  309.  
  310.  
  311.           DORINFO1.DEF and LOCAL.DEF
  312.           --------------------------
  313.  
  314.           1-Edit requires a DORINFO1.DEF file to be present when
  315.           starting.  First, some background on this file, then info on
  316.           how to get around the necessity of having it available to
  317.           1-Edit when using the program locally.
  318.  
  319.           Anytime QuickBBS calls a child program (a door) via a Type 7
  320.           or Type 15 exit, it creates two files: a DORINFO1.DEF file and
  321.           an EXITINFO.BBS.  Both contain information about the user
  322.           online at the time the door is started -- information like
  323.           baud rate, com port, time remaining, security level.  When you
  324.           return to QuickBBS from the shell, both of these files are
  325.           deleted automatically -- which is why you can never find them
  326.           on your disk after running a door.
  327.  
  328.           1-Edit uses only the DORINFO1.DEF file to get information
  329.           about the user.  Because the file is required, and because one
  330.           won't always be available (such as when running 1-Edit
  331.           outside of QuickBBS), I've made the program search for a
  332.           second file called LOCAL.DEF.  LOCAL.DEF is nothing but a copy
  333.           of a DORINFO1.DEF which should stay in your QuickBBS system
  334.           directory (usually C:\QBBS\).  Just put it there and leave it
  335.           there, and 1-Edit will always know where to find it when it's
  336.           needed.
  337.  
  338.           A copy of a LOCAL.DEF file is included in the 1-Edit archive.
  339.           You'll want to edit it to reflect your name and system name.
  340.           Here's what one looks like with my comments in braces { }:
  341.           ---------------------------------------------------------
  342.           THE CREATIVE CONNECTION-SOUTHFIELD, MI-(313)559-9039
  343.           BOB                    {Sysop first name}
  344.           RANSOM                 {Sysop last name}
  345.           COM0                   {Don't edit this! COM0 = Local}
  346.           0 Baud,N,8,1           {No need to edit this}
  347.           0                      {This does nothing; just a zero}
  348.           BOB                    {User's first name}
  349.           RANSOM                 {User's last name}
  350.           SOUTHFIELD, MI         {No need to edit; not used}
  351.           1                      {Graphics mode; no need to edit]
  352.           32000                  {Security level}
  353.           235                    {Time remaining}
  354.           ---------------------------------------------------------
  355.  
  356.  
  357.           1-Edit Documentation                             Page 5
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.           Feel free to edit the LOCAL.DEF file to suit yourself.
  369.           However, the COM port setting MUST remain as COM0 to indicate
  370.           a local logon.  Changing the security level, time remaining,
  371.           etc., is up to you.  After editing, place the file into your
  372.           QuickBBS system directory and leave it there.
  373.  
  374.  
  375.           Direct Screen Writes
  376.           --------------------
  377.  
  378.           1-Edit defaults to using direct screen writes when you're
  379.           logged on locally.  This speeds up the program immensely but
  380.           may cause problems with some multitaskers.  The command line
  381.           parameter -D will disable these direct screen writes, forcing
  382.           all screen writes through DOS.  More on this and other command
  383.           line parameters is detailed later.
  384.  
  385.  
  386.           Locked COM Ports
  387.           ----------------
  388.  
  389.           Locked ports are supported automatically by 1-Edit.  No need
  390.           to use DORSPEED, SETSPEED, etc.  1-Edit has been successfully
  391.           tested at up to 38,400 baud.
  392.  
  393.  
  394.           Directories
  395.           -----------
  396.  
  397.           1-Edit may be run from whatever directory you choose
  398.           provided you have the environment QUICK set (i.e.
  399.           "SET QUICK=C:\QBBS\".  See your DOS manual for more details on
  400.           setting and using environment variables.)  If you DON'T set
  401.           the QUICK variable, you MUST run 1-Edit from your main
  402.           QuickBBS directory.
  403.  
  404.           When first started, 1-Edit looks for the above mentioned
  405.           environment variable.  If found, 1-Edit then looks there for
  406.           your configuration files.  If not found, 1-Edit assumes that
  407.           the config files are in the current working directory.
  408.           QUICKCFG.DAT is then read to check the location of your menu
  409.           directory and USERS.BBS file.  Local screen messages will tell
  410.           you what's going on, which path the program is choosing, etc.
  411.  
  412.           Okay, so now you've unarchived the program and put it
  413.           somewhere on your harddrive, paying attention to the QUICK
  414.           variable (if set, 1-Edit can go anywhere; if not, 1-Edit must
  415.  
  416.  
  417.           1-Edit Documentation                             Page 6
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.           be in your main QuickBBS directory).  You've also put the
  428.           LOCAL.DEF file into your main QuickBBS directory (regardless
  429.           of what QUICK is set to, LOCAL.DEF belongs in the main
  430.           directory.)  Now you're almost ready to get started.
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.           1-Edit Documentation                             Page 7
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.                  +---------------------------------------------+
  488.                  |             COMMAND LINE SYNTAX             |
  489.                  +---------------------------------------------+
  490.  
  491.  
  492.           1-Edit allows you to customize it somewhat via the command
  493.           line.  All of the following command line parameters are
  494.           optional:
  495.  
  496.           -Nxxxxxx   Tells 1-Edit to look in path xxxxxx for the
  497.                      DORINFO1.DEF, LOCAL.DEF, and QUICKCFG.DAT
  498.                      files.  Example: "-Nc:\qbbs\line1"  or
  499.                      "-Nc:\qbbs\line*N" (which lets QuickBBS insert the
  500.                      actual node number in place of *N). A trailing
  501.                      backslash is optional.  The actual drive and path
  502.                      statement is also optional.  If left blank 1-Edit
  503.                      will first search the current directory for the
  504.                      necessary files before attempting to find them
  505.                      elsewhere.
  506.  
  507.           -Uxxxxxx   Tells 1-Edit to look in path xxxxxx for the
  508.                      USERS.BBS file.  Example: "-Uc:\qbbs\users"
  509.                      A trailing backslash is optional.  This is a
  510.                      rarely used command.
  511.  
  512.           -Fxx       Sets foreground color to xx.  xx must be 0-15.
  513.                      Default color is bright cyan (#11).  Example: -F6
  514.  
  515.           -Hxx       Sets the highlight color to xx.  xx must be
  516.                      0-15.  Default highlight color is bright yellow
  517.                      (#14).  Example: -H12
  518.  
  519.           -Sxxxxx    Sets the minimum security level for accessing
  520.                      the Drop To DOS feature to xxxxx.  xxxxx must
  521.                      be 0-64000.  Default is 32000.  (More on this
  522.                      feature later.)  Example: -S100
  523.  
  524.           -D         Stops 1-Edit from using direct screen writes with
  525.                      local logons.  With this parameter all screen
  526.                      writes will be through DOS.   Remote logons will
  527.                      have all writes sent through DOS, regardless of
  528.                      this parameter.
  529.  
  530.           -J         Turns on security "jumping."  More on this
  531.                      later.
  532.  
  533.           -M         Causes 1-Edit to not allow menu editing.  The
  534.                      menu editor won't even show up on the main menu.
  535.  
  536.  
  537.           1-Edit Documentation                             Page 8
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.           -X         For use with the QuickBBS *W command that allows
  549.                      users to jump straight from reading messages into
  550.                      an external user editor, so that you may
  551.                      immediately edit the user record of the message's
  552.                      author.  Example: -X*W
  553.  
  554.           ? or -?    Brings up a short help screen outlining these
  555.                      command line parameters.
  556.  
  557.           None of these parameters are required; use any, all, or none
  558.           of them as you choose.  You may use them in any order and case
  559.           doesn't matter.  Several of these are discussed in more detail
  560.           later, so don't worry if you don't yet understand their uses.
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.           1-Edit Documentation                             Page 9
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.                  +---------------------------------------------+
  608.                  |                GETTING STARTED              |
  609.                  +---------------------------------------------+
  610.  
  611.  
  612.           With that stuff out of the way, we'll get on to the meat of
  613.           the program and how to make it run.  I won't bother taking you
  614.           through each and every option of both editors -- most
  615.           everything is self-explanatory so I'll just touch on some
  616.           things and highlight the few oddities.  Any sysop that has
  617.           gotten QuickBBS up and running shouldn't have any problems.
  618.  
  619.  
  620.           Setting Up A Menu For 1-Edit
  621.           ----------------------------
  622.  
  623.           1-Edit works both as a Type 7 or a Type 15 door.  However,
  624.           there's no need that I can see to ever run it as a Type 15.
  625.           Even under very tight memory constraints, the Type 7 (used
  626.           with QuickBBS's *M data line parameter) should work fine.  By
  627.           the way, the *M parameter causes QuickBBS to swap itself to
  628.           EMS or disk during the Type 7 shell, leaving you with nearly
  629.           all of your available DOS to run 1-Edit.
  630.  
  631.           Here's a sample of a Type 7 setup as it would look from within
  632.           the new Menuedit:
  633.  
  634.           ------(this screen has been edited to fit the page)----
  635.           ┌───────────────────────────────────────────────────────────
  636.           │                             Editing Entry #: 21
  637.           │         1         2         3         4         5
  638.           │12345678901234567890123456789012345678901234567890123456789
  639.           │<1> .............. Use 1-Edit Remote Editor················
  640.           │
  641.           │Optional Data:
  642.           │1-EDIT.EXE *M··············································
  643.           │
  644.           │Menu Type....>7··
  645.           │Security.....>50··· ╓──────────────────────Keys In Use─────
  646.           │Key..........>1     ║?????ABCDFGLMOTUVY#1?
  647.           │ForeGround...>11    ╙───────────────────────────────────────
  648.           │BackGround...>0·
  649.           │A Flags......>X------- ╔════════════════════Shift-FKeys═════
  650.           │B Flags......>-------- ║ F1-┌ F2-┐ F3-└ F4-┘ F5-─ F6-│ F7-├
  651.           │C Flags......>-------- ║         (Use ALT-FKeys To Change Ch
  652.           │D Flags......>-------- ╚════════════════════════════════════
  653.           │
  654.           │                       [F1] to Finish and Save Changes
  655.  
  656.  
  657.           1-Edit Documentation                             Page 10
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.           │                    [ESC] To Abort Changes To This Entry
  668.           │    [HOME]-Beginning of Line, [END]-End of Line, [INS]-Toggl
  669.           │               [F2]-Center Display Line, [F10]-Menu Type Hel
  670.           │
  671.           └────────────────────────────────────────────────────────────
  672.  
  673.           ---------------------------------------------------------
  674.           I think that gives you the basic idea of what it looks like.
  675.           If you choose to use some of 1-Edit's command line options,
  676.           the above data line might read:
  677.  
  678.           Optional Data:
  679.           1edit.exe *M -Nc:\qbbs\line*N -F7 -H15 -J
  680.  
  681.           Note that the above uses both the QuickBBS *N and *M
  682.           parameters: *M to swap QuickBBS to EMS or disk; *N causes
  683.           QuickBBS to put the current node number in place of the *N.
  684.           See your QuickBBS docs for more info on these and other usable
  685.           Type 7 parameters.
  686.  
  687.  
  688.           The QuickBBS *W Command
  689.           -----------------------
  690.  
  691.           This new command, added into v2.76, allows you to jump
  692.           directly from reading messages to an external user editor.  To
  693.           set up 1-Edit for this type of operation, go into QCONFIG
  694.           under GENERAL then OTHER.  At the bottom of the page is a
  695.           field for External User Editor.  Set yours up something like
  696.           this:
  697.  
  698.           1EDIT.EXE *M -X*W
  699.  
  700.           You may use any additional command line parameters you wish,
  701.           and you may leave off the *M command (swaps QuickBBS to disk
  702.           or EMS when 1-Edit loads) if you wish.  Note: There should be
  703.           NO SPACES BETWEEN -X AND *W.  Jam them right together.  Now,
  704.           when you're reading messages in QuickBBS and hit the
  705.           "<O>ptions" then "<U>ser" commands, you'll jump straight from
  706.           the BBS into 1-Edit's user editor, landing on the proper user
  707.           record -- provided that user's record can be found.  1-Edit
  708.           will search both the Name and Alias fields for a match.  If no
  709.           match is found you'll be notified and, after pressing [ENTER],
  710.           you'll exit straight out of 1-Edit back in to QuickBBS.
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.           1-Edit Documentation                             Page 11
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726.  
  727.           Actual Startup
  728.           --------------
  729.  
  730.           When you first crank up 1-Edit, it will check to see that a
  731.           FOSSIL is present.  If not, the program aborts.  From there it
  732.           begins its search for QUICKCFG.DAT and DORINFO1.DEF, using
  733.           LOCAL.DEF if necessary.  Some values are initialized and
  734.           you're told (on the local screen only) where it's taking the
  735.           files from.  Then an opening screen pops up.  If the program
  736.           is unregistered, the program will ring the bell a few times,
  737.           then pause for 4 seconds to <ahem> encourage registration.
  738.           After the pause you'll be prompted to "Press [ENTER] to
  739.           continue:".  Press Enter and you'll get the main menu.
  740.  
  741.           From the main menu you may choose to edit the user files, menu
  742.           files, or drop to DOS.  At this point, registered versions of
  743.           1-Edit will show a status line on the local console detailing
  744.           who's online, baud and modem settings, and time remaining.
  745.           Unregistered versions show only the line "Unregistered
  746.           Evaluation Copy".
  747.  
  748.           A quick side note:  Throughout most of the program, pressing
  749.           [ENTER] or entering a question mark ("?") at any menu will
  750.           redraw the screen.  This is really only useful in times of
  751.           high line noise but it's nice to have available when you need
  752.           it.
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.           1-Edit Documentation                             Page 12
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.                  +---------------------------------------------+
  788.                  |                THE MENU EDITOR              |
  789.                  +---------------------------------------------+
  790.  
  791.  
  792.           Those of you familiar with Adam Hudson's original Menuedit
  793.           program will feel right at home here.  When you first choose
  794.           the menu editor from the main menu, you'll be presented with a
  795.           list of the menus in your QuickBBS menu directory.  After
  796.           displaying all of the menus you'll have the option of
  797.           editing/adding a menu, renaming a menu, copying a menu,
  798.           deleting a menu, or relisting the files.
  799.  
  800.           There's no need to explain most of these functions.  One thing
  801.           you might like to know is that any rename, delete, or copy
  802.           operation can be stopped by pressing [ENTER] on a blank input
  803.           field.
  804.  
  805.           Choose the <E> option and you'll be prompted for the menu
  806.           name.  If the menu isn't found, you'll be asked if you wish to
  807.           create it.  If the menu exists, or if you do want to create
  808.           it, you'll be dropped into the actual menu editor.  From here
  809.           you can do a variety of things, all very similar to the old
  810.           Menuedit.
  811.  
  812.           Rather than beat a dead horse trying to detail each and every
  813.           function of this editor, you should just play with the thing
  814.           for a while.  Copy an existing menu to another menu file
  815.           called TEST or FRED or something.  Then hack away on the
  816.           copied menu.  You'll get the hang of it in no time.
  817.  
  818.           Something you should know: When "<C>hanging" a menu line (this
  819.           is how you actually edit an existing menu) you may move from
  820.           menu line to menu line by pressing the plus (+) or minus (-)
  821.           keys to move forward or backward.  Users who have their modem
  822.           Escape Guard Time (S12) set too low may have problems with the
  823.           plus key, and may use the < or > keys to move around.  When
  824.           you hit the beginning or end of a menu, the editor will "wrap
  825.           around" from the end to the beginning, or vice versa.
  826.           Example: You have a 20 line menu.  At line 20 you hit the plus
  827.           key.  You will "wrap around" to line 1.
  828.  
  829.           Oh, something else you should know: When editing a field in
  830.           either editor (menu or user), as soon as you punch [ENTER] the
  831.           new value, if it's not blank, is written to disk.  If it *is*
  832.           blank, nothing is written and you exit the procedure.  The
  833.           immediate write to disk is done so that, should carrier drop
  834.           unexpectedly, all of your changes are already stored.
  835.  
  836.  
  837.           1-Edit Documentation                             Page 13
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.           Okay, one last thing to tell you:  If you have a copy of
  849.           Menuedit's MENUEDIT.HLP file in your system directory, 1-Edit
  850.           will read this file when you're adding or changing a line of a
  851.           menu.  This help file contains a thumbnail sketch of all the
  852.           different menu types -- which is handy to have when a printed
  853.           copy of the docs isn't easily available.
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.           1-Edit Documentation                             Page 14
  898.  
  899.  
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907.                  +---------------------------------------------+
  908.                  |                THE USER EDITOR              |
  909.                  +---------------------------------------------+
  910.  
  911.  
  912.           Most all of this section should be pretty easy to figure out.
  913.           Press the plus (+) key to move the next user, or the minus (-)
  914.           key to move to the previous user.  Again, if you have problems
  915.           with + or - you may use < or > instead.  When moving from user
  916.           to user, if you hit the beginning or end of the USERS.BBS
  917.           file, the program will "wrap around" to the next user.
  918.           Example: You come to the last user in the file, say it's user
  919.           #100, then press the plus key (+) one more time.  The program
  920.           will "wrap around" back to user #0 (the first user in the
  921.           file).
  922.  
  923.           Pick and choose any fields you want to edit, press the
  924.           bracketed key <>, and you can edit away.  Should you start to
  925.           edit a field, then decide against it, just press [ENTER] over
  926.           a blank edit field and that field will remain unchanged.
  927.  
  928.           At the bottom of the screen you'll see a small window with
  929.           choices to add a user, delete a user, find a user, etc.
  930.           <Q>uit takes you back to the main menu.  <O>ther clears this
  931.           small window and replaces it with a second window of other
  932.           editing options.  To return to the first set of options, press
  933.           <O> again.
  934.  
  935.  
  936.           Mass Updates
  937.           ------------
  938.  
  939.           With 1-Edit, you have the ability to do two types of mass
  940.           updating (changes made to every user in the file).  You can do
  941.           mass updates of a flag.  For example, you could turn every
  942.           user's B1 flag ON.
  943.  
  944.           You may also mass update everyone's "High Message Read"
  945.           number.  This is something you won't need often, if ever, but
  946.           it's handy to have.  The usual reason for changing everyone's
  947.           High Message Read is after blowing up your message base
  948.           through some botched operation, leaving you with no choice but
  949.           to delete all the message files and start over again.
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.           1-Edit Documentation                             Page 15
  958.  
  959.  
  960.  
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.           Security "Jumping" (aka "the -J parameter")
  968.           -------------------------------------------
  969.  
  970.           By default, any user that has access to 1-Edit can edit *any*
  971.           user record.  (See below about editing your own record.)  For
  972.           some sysops, those with remote cosysops, this can sometimes
  973.           cause a problem.  You may wish to allow a user to edit *some*
  974.           user records, but not all.  That's what the "-J" does.  Add it
  975.           to your 1-Edit command line and the program will conveniently
  976.           skip any record in the USERS.BBS where the security level is
  977.           greater than the user's own security level.  For example, say
  978.           your remote sysop has a security level of 100.  With the "-J"
  979.           on the command line, 1-Edit won't let him/her even see, much
  980.           less edit, records where the security level is 101 or greater.
  981.           Also, unlike previous versions, the user won't be able to
  982.           raise anyone's level higher than his/her own nor will he/she
  983.           be able to add a new user with a higher level.
  984.  
  985.  
  986.           Editing Your Own User Record
  987.           ----------------------------
  988.  
  989.           To put it simply, you can't do it with 1-Edit.  1-Edit edits
  990.           only the USERS.BBS and related files and doesn't work with the
  991.           EXITINFO.BBS file at all.  I hear about this "bug" all the
  992.           time.  People tell me how they went in and changed several
  993.           fields in their own record, only to exit 1-Edit and QuickBBS
  994.           and find that the changes mysteriously disappeared.  The
  995.           reason is pretty simple and goes all the way back to the very
  996.           first versions of QuickBBS.
  997.  
  998.           Here's what happens:  When a user logs onto QuickBBS, his or
  999.           her user record is read into memory.  Any changes that
  1000.           QuickBBS would make to that record are held in memory (but not
  1001.           written to disk) until the user logs off.  At logoff, the
  1002.           user's record is completely rewritten by QuickBBS with the new
  1003.           data.  If, during the user's online session, the user changes
  1004.           his/her own record, those changes are written to disk by
  1005.           1-Edit -- but those changes are completely overwritten again
  1006.           by QuickBBS at logoff.
  1007.  
  1008.           The simplest way around this (with 1-Edit) is to logon using
  1009.           another name (maybe create a user account called "Test User"
  1010.           or somesuch), edit your "real" user record, then log off.  Or
  1011.           wait to make changes to your record until you can do so by
  1012.           running a user editor directly from DOS.
  1013.  
  1014.  
  1015.  
  1016.  
  1017.           1-Edit Documentation                             Page 16
  1018.  
  1019.  
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.  
  1026.  
  1027.           1-Edit Lite (1EDITL.EXE)
  1028.           ------------------------
  1029.  
  1030.           I've had a few requests in the past from sysops who like
  1031.           1-Edit but really have no use for the menu editor.  For them
  1032.           I've created 1-Edit Lite, a slightly smaller version of 1-Edit
  1033.           that contains only the user editor.  You move directly from
  1034.           the opening title screen to the user editor with no stops
  1035.           inbetween.  1-Edit Lite functions exactly the same as 1-Edit,
  1036.           minus the menu editor and drop to DOS feature (see below).
  1037.           All command line parameters are supported in the Lite version.
  1038.           Really, there's no difference in the code except the menu
  1039.           editing routines weren't compiled in.
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.           1-Edit Documentation                             Page 17
  1078.  
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084.  
  1085.  
  1086.  
  1087.                  +---------------------------------------------+
  1088.                  |              DROP TO DOS FEATURE            |
  1089.                  +---------------------------------------------+
  1090.  
  1091.  
  1092.           Please read this section carefully!
  1093.  
  1094.           Dropping to DOS through 1-Edit can be handy at times but can
  1095.           also lock your computer up if you don't pay attention to what
  1096.           you're doing.
  1097.  
  1098.           Before attempting to use this feature, double check that the
  1099.           DOS environment variable COMSPEC is set properly.  To check
  1100.           this, type SET at a DOS prompt.  Your environment will be
  1101.           displayed for you.  You should see "COMSPEC=" and the
  1102.           drive/path to your COMMAND.COM file.  If this *isn't* set
  1103.           properly, please consult your DOS manual.
  1104.  
  1105.           When displaying the main menu, 1-Edit checks the user's
  1106.           security level (as set in DORINFO1.DEF) against the security
  1107.           level set on the command line (or the default value, 32000).
  1108.           If the user's level equals or exceeds that level, the Drop to
  1109.           DOS function appears on the main menu.  If the user's level is
  1110.           *less* than the specified level, the option doesn't appear and
  1111.           won't function.  This allows you to have cosysops helping you
  1112.           edit your user and menu records without actually allowing them
  1113.           to enter DOS.
  1114.  
  1115.           Drop to DOS works two different ways, depending on whether
  1116.           you're using the program locally or remotely.
  1117.  
  1118.  
  1119.           Local Drop to DOS
  1120.           -----------------
  1121.  
  1122.           When in local mode, the Drop to DOS is just a very simple
  1123.           shell.  You hit "D" and you get the familiar flashing cursor.
  1124.           (What actually happens is a second copy of COMMAND.COM is
  1125.           loaded.)  You may run whatever you need to run from here.
  1126.           When you're ready to return to 1-Edit, just type EXIT and
  1127.           press [ENTER].
  1128.  
  1129.  
  1130.           Remote Drop to DOS
  1131.           ------------------
  1132.  
  1133.           Things get a little more complicated when dropping to DOS
  1134.           remotely.  First, when you do drop to DOS, 1-Edit goes on
  1135.  
  1136.  
  1137.           1-Edit Documentation                             Page 18
  1138.  
  1139.  
  1140.  
  1141.  
  1142.  
  1143.  
  1144.  
  1145.  
  1146.  
  1147.           hold.  It no longer monitors carrier, it doesn't feed screen
  1148.           displays to the modem or read incoming data from the modem,
  1149.           nor does the user inactivity timeout function work.  This is
  1150.           exactly the same as when you shell out from QuickBBS via a
  1151.           Type 7 or 15 menu option -- all BBS functions stop cold.
  1152.           Whatever you run here *must* be able to send info through the
  1153.           modem, read incoming data from the modem, and check carrier.
  1154.           QuickBBS won't do it for you after executing a Type 7 or 15
  1155.           menu option, and 1-Edit won't do it for you when you <D>rop to
  1156.           DOS.
  1157.  
  1158.           When you do execute the Drop to DOS remotely, you'll be
  1159.           prompted for a filename to execute.  Leave this field blank
  1160.           and you'll be returned to 1-Edit.  If you do execute a program
  1161.           or batch file, you MUST INCLUDE THE FILE EXTENSION WITH THE
  1162.           FILENAME (i.e. ".EXE", ".COM", ".BAT").  You may also include
  1163.           as many command line parameters as will fit into the field.
  1164.           The parameters will be passed on to the child program.  When
  1165.           you exit the child program, you'll be returned to 1-Edit
  1166.           automatically.
  1167.  
  1168.  
  1169.           DOSSHELL.BAT
  1170.           ------------
  1171.  
  1172.           A sample batch file called DOSSHELL.BAT is included in the
  1173.           1-Edit archive for you to look over.  It details how you can
  1174.           set up a true "drop to DOS" from 1-Edit using CTTY.COM or
  1175.           Gateway.  THIS IS NOT MEANT TO BE A READY-TO-RUN BATCH FILE!
  1176.           Use it only as a guide.  If you do decide to try it out, be
  1177.           sure to pass your baud rate to DOSSHELL.BAT on the command
  1178.           line as:  DOSSHELL.BAT 2400  (or whatever baud rate you're
  1179.           using.)  You should read and test this batch file carefully
  1180.           before relying on it!!!  I can't stress that enough.  Also,
  1181.           you should add to it some sort of carrier detect TSR, like
  1182.           WATCHCD, before using it.  WATCHCD (and the related BOOT.COM)
  1183.           are available in all versions of the X00 FOSSIL driver.
  1184.  
  1185.           Better yet, get a copy of DOORWAY, a great program that lets
  1186.           you run nearly anything as a door with complete carrier
  1187.           detection.  It's shareware and registration is pretty cheap.
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.           1-Edit Documentation                             Page 19
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.                  +---------------------------------------------+
  1208.                  |      USING 1-Edit ON MULTI-NODE SETUPS      |
  1209.                  +---------------------------------------------+
  1210.  
  1211.  
  1212.           Typically when running a multi-node QuickBBS set up, you will
  1213.           have your directories set similar to this:
  1214.  
  1215.           C:\QBBS\        =  Main System Directory.  Your QUICK
  1216.                              environment variable points here.
  1217.  
  1218.           C:\QBBS\NODEx\  =  Separate directories for each node that
  1219.                              you run, where "x" equals the node
  1220.                              number.
  1221.  
  1222.           Your actual directory names may be different though many
  1223.           people seem to follow this example as outlined in the QuickBBS
  1224.           docs.
  1225.  
  1226.           Under single node setups, your config files (QUICKCFG.DAT et
  1227.           al) live in the System directory.  This is also where QuickBBS
  1228.           puts the DORINFO1.DEF file when executing a Type 7 or Type 15
  1229.           menu option.  Under multi-node setups, the config files live
  1230.           in each line directory, and the DORINFO1.DEF is placed in the
  1231.           proper line directory, too.  Under these situations, you'll
  1232.           need the following parameter to help 1-Edit figure out what is
  1233.           going on and where to look for files:
  1234.  
  1235.  
  1236.           The -N Parameter
  1237.           ----------------
  1238.  
  1239.           When 1-Edit detects the -N parameter on the command line, it
  1240.           will search the directory specified after the -N for both the
  1241.           DORINFO1.DEF file and the QUICKCFG.DAT file.  If the files are
  1242.           found, they will be used.  If either file is not found in the
  1243.           specified directory, 1-Edit will fall back and attempt to
  1244.           locate the files in the main System directory.
  1245.  
  1246.           In the case of the QUICKCFG.DAT file being missing from both
  1247.           the specified -N parameter directory *and* from the System
  1248.           directory (pretty much impossible if your system actually
  1249.           works), the program will abort.
  1250.  
  1251.           If the DORINFO1.DEF file isn't found in the -N specified
  1252.           directory nor in the System directory, 1-Edit will search the
  1253.           System directory for the LOCAL.DEF file.  There's no need to
  1254.           put a copy of LOCAL.DEF into each line directory; one copy in
  1255.  
  1256.  
  1257.           1-Edit Documentation                             Page 20
  1258.  
  1259.  
  1260.  
  1261.  
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.           the System directory is all that's needed.
  1268.  
  1269.           However, if the -N parameter is used by itself, with no path
  1270.           immediately following it, 1-Edit will look for QUICKCFG.DAT
  1271.           and DORINFO1.DEF first in the *current directory*, then will
  1272.           fall back to searching the system directory.
  1273.  
  1274.  
  1275.  
  1276.  
  1277.           Here's an example of the -N parameter in use:
  1278.  
  1279.           1EDIT.EXE -Nc:\qbbs\node1
  1280.  
  1281.                   - or -
  1282.  
  1283.           1EDIT.EXE -Nc:\qbbs\node*N
  1284.  
  1285.                   - or -
  1286.  
  1287.           1EDIT.EXE -N
  1288.  
  1289.           A trailing backslash is optional.  Note the "*N" in the second
  1290.           example.  This utilizes a feature of QuickBBS (mentioned
  1291.           earlier) where QuickBBS will substitute the node number for
  1292.           the "*N" when executing a Type 7 or Type 15 shell.
  1293.  
  1294.  
  1295.           The -U Parameter
  1296.           ----------------
  1297.  
  1298.           This tells 1-Edit to get the USERS.BBS from the directory
  1299.           specified after the -U.  Example:
  1300.  
  1301.           1EDIT.EXE -Uc:\qbbs\users\
  1302.  
  1303.           As before, a trailing backslash is optional.
  1304.  
  1305.           This is probably not going to be the most used parameter as
  1306.           most folks maintain only a single user file.  But just in
  1307.           case, it's here...
  1308.  
  1309.           One thing to note about this parameter's use:  If 1-Edit can't
  1310.           find the USERS.BBS file in the specified directory, the
  1311.           program won't search elsewhere for it.  It will simply abort
  1312.           with an error code.
  1313.  
  1314.  
  1315.  
  1316.  
  1317.           1-Edit Documentation                             Page 21
  1318.  
  1319.  
  1320.  
  1321.  
  1322.  
  1323.  
  1324.  
  1325.  
  1326.  
  1327.                  +---------------------------------------------+
  1328.                  |             REGISTERING 1-EDIT              |
  1329.                  +---------------------------------------------+
  1330.  
  1331.  
  1332.           Keys
  1333.           ----
  1334.  
  1335.           1-Edit uses a "keyed" registration system similar to that used
  1336.           by QuickBBS.  The information contained in your QUICKCFG.DAT
  1337.           file under Sysop Name and BBS Name are used to create your
  1338.           key.  Unregistered versions of the program (programs running
  1339.           without the key) ring the bell and have a 4 second pause built
  1340.           into the beginning of the program.  Also, the status line is
  1341.           disabled.  Registered versions of the program kill the beeping
  1342.           and 4 second pause and enable the status line.  Registered
  1343.           versions also show the sysop name and system name on the title
  1344.           screen when 1-Edit is started.  These are the ONLY differences
  1345.           between registered and unregistered.  There are no built-in
  1346.           self-destruct mechanisms or anything like that.
  1347.  
  1348.           When you register 1-Edit, you will receive a small key file
  1349.           that will disable the ringing and pause, and enable the status
  1350.           line.  If you're a member of Fidonet, your key file will be
  1351.           delivered by netmail file attach.  If you're not in Fidonet, I
  1352.           may try to upload your key to your BBS (if you're in the
  1353.           continental U.S. or English-speaking Canada).  If I'm unable
  1354.           to get through, or if you're outside the continental U.S. and
  1355.           Canada, I'll send the key through regular mail.  I've found
  1356.           Fidonet delivery to be faster, cheaper, and easier, regardless
  1357.           of where you are in the world, so I attempt to use that method
  1358.           whenever possible.  Uploads to your BBS are usually the second
  1359.           fastest, cheapest method.  Snail mail gets used only if
  1360.           there's no other inexpensive way to get the key to you.
  1361.  
  1362.  
  1363.           Installing Keys
  1364.           ---------------
  1365.  
  1366.           When you receive your keyfile, it may come to you named
  1367.           something like LASTNAME.KEY (where LASTNAME is your lastname).
  1368.           If so, please rename it to 1EDIT.KEY, and place it into your
  1369.           main QuickBBS System directory.  Be very careful with the
  1370.           filename of this key:  It must be called 1EDIT.KEY (and NOT
  1371.           1-EDIT.KEY).
  1372.  
  1373.           Leave this key in place for as long as you use 1-Edit.  It
  1374.           will be good for all future versions of the program.  Or, if
  1375.  
  1376.  
  1377.           1-Edit Documentation                             Page 22
  1378.  
  1379.  
  1380.  
  1381.  
  1382.  
  1383.  
  1384.  
  1385.  
  1386.  
  1387.           for some reason I change the key encryption in a future
  1388.           version, I'll send you a new key before releasing the new
  1389.           version.
  1390.  
  1391.           F.Y.I.:  There's no difference between the keys for the
  1392.           QuickBBS version of this program and the RemoteAccess version
  1393.           (1-Edit-RA) except the filename.  If you are switching to
  1394.           QuickBBS from RA and have a valid key for 1-Edit-RA, just
  1395.           rename the key to 1EDIT.KEY.
  1396.  
  1397.  
  1398.           Registering
  1399.           -----------
  1400.  
  1401.           A form is included in the program archive.  Please complete
  1402.           the form and mail it along with your check or money order for
  1403.           $10.00 (U.S. funds only) to the address on the form.  Your key
  1404.           will be sent to you within a few days of receipt.
  1405.  
  1406.           Please be VERY careful when completing the registration form
  1407.           that your Sysop Name and BBS Name are EXACTLY as they appear
  1408.           in your QuickBBS configuration.
  1409.  
  1410.  
  1411.  
  1412.  
  1413.  
  1414.  
  1415.  
  1416.  
  1417.  
  1418.  
  1419.  
  1420.  
  1421.  
  1422.  
  1423.  
  1424.  
  1425.  
  1426.  
  1427.  
  1428.  
  1429.  
  1430.  
  1431.  
  1432.  
  1433.  
  1434.  
  1435.  
  1436.  
  1437.           1-Edit Documentation                             Page 23
  1438.  
  1439.  
  1440.  
  1441.  
  1442.  
  1443.  
  1444.  
  1445.  
  1446.  
  1447.                  +---------------------------------------------+
  1448.                  |                    THE END                  |
  1449.                  +---------------------------------------------+
  1450.  
  1451.  
  1452.           Okay, I guess that covers it.  Hopefully this file is complete
  1453.           enough that you can figure out how to use the program.  Should
  1454.           you encounter a problem of some sort or an unfound bug, please
  1455.           be sure to let me know.  Suggestions for enhancements are
  1456.           always welcome, to.
  1457.  
  1458.           You can contact me via the QuickBBS Support echo, the QuickPRO
  1459.           echo, by netmail, or by regular mail.
  1460.  
  1461.           The current version of this program will always be available
  1462.           for file request or first call download on my system.  File
  1463.           request the magic name: 1EDIT
  1464.  
  1465.           -Bob Ransom
  1466.            27840 Lathrup Blvd.
  1467.            Lathrup Village, Michigan  48076
  1468.            U.S.A.
  1469.  
  1470.            The Creative Connection BBS
  1471.            24 hours / 7 days
  1472.            300-1200-2400 baud / 8-N-1
  1473.            (313) 559-9039
  1474.            Fidonet 1:120/96
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480.  
  1481.  
  1482.  
  1483.  
  1484.  
  1485.  
  1486.  
  1487.  
  1488.  
  1489.  
  1490.  
  1491.  
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.           1-Edit Documentation                             Page 24
  1498.  
  1499.  
  1500.  
  1501.